<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dp12rxss: xdprxss_hdcp_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dp12rxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdprxss__hdcp__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xdprxss_hdcp_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the <a class="el" href="struct_x_dp_rx_ss.html" title="The DisplayPort RX Subsystem driver instance data. ">XDpRxSs</a> driver in single stream (SST) transport or multi-stream transport (MST) mode and enables HDCP. </p>
<dl class="section note"><dt>Note</dt><dd>For this example to display output, the user need to implement initialization of the system (DpRxSs_PlatformInit), Video Phy (DpRxSs_VideoPhyInit), start DisplayPort RX subsystem (XDpRxSs_Start) and DisplayPort RX Subsystem setup (DpRxSs_Setup). The input to the Subsystem is from RX (GT). The functions DpRxSs_PlatformInit, DpRxSs_VideoPhyInit and DpRxSs_Setup are declared and are left up to the user to implement. In addition to the setups, this example requires to implement required interrupts to view the output.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver  Who Date     Changes
</p>
<hr/>
<p>
1.00 sha 10/05/15 Initial release.
4.00 ms  01/23/17 Modified xil_printf statement in main function to
                  ensure that "Successfully ran" and "Failed" strings
                  are available in all examples. This is a fix for
                  CR-965028.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a33c9dce40424c29784819adc27eaf94e"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdprxss__hdcp__example_8c.html#a33c9dce40424c29784819adc27eaf94e">DpRxSs_HdcpExample</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:a33c9dce40424c29784819adc27eaf94e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the main entry point for the HDCP example using the <a class="el" href="struct_x_dp_rx_ss.html" title="The DisplayPort RX Subsystem driver instance data. ">XDpRxSs</a> driver.  <a href="#a33c9dce40424c29784819adc27eaf94e">More...</a><br/></td></tr>
<tr class="separator:a33c9dce40424c29784819adc27eaf94e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26fb3eace6447299bbdedd12b314a6a8"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdprxss__hdcp__example_8c.html#a26fb3eace6447299bbdedd12b314a6a8">DpRxSs_PlatformInit</a> (void)</td></tr>
<tr class="memdesc:a26fb3eace6447299bbdedd12b314a6a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initialize required platform specific peripherals.  <a href="#a26fb3eace6447299bbdedd12b314a6a8">More...</a><br/></td></tr>
<tr class="separator:a26fb3eace6447299bbdedd12b314a6a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a416674ea3b4fb518b781478d20c6bc51"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdprxss__hdcp__example_8c.html#a416674ea3b4fb518b781478d20c6bc51">DpRxSs_VideoPhyInit</a> (void)</td></tr>
<tr class="memdesc:a416674ea3b4fb518b781478d20c6bc51"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures Video Phy.  <a href="#a416674ea3b4fb518b781478d20c6bc51">More...</a><br/></td></tr>
<tr class="separator:a416674ea3b4fb518b781478d20c6bc51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae690e4e95545e8f6b37672430f1f910a"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdprxss__hdcp__example_8c.html#ae690e4e95545e8f6b37672430f1f910a">DpRxSs_Setup</a> (void)</td></tr>
<tr class="memdesc:ae690e4e95545e8f6b37672430f1f910a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures DisplayPort RX Subsystem.  <a href="#ae690e4e95545e8f6b37672430f1f910a">More...</a><br/></td></tr>
<tr class="separator:ae690e4e95545e8f6b37672430f1f910a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdprxss__hdcp__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the main function for <a class="el" href="struct_x_dp_rx_ss.html" title="The DisplayPort RX Subsystem driver instance data. ">XDpRxSs</a> SST/MST example.  <a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">More...</a><br/></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a33c9dce40424c29784819adc27eaf94e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 DpRxSs_HdcpExample </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the main entry point for the HDCP example using the <a class="el" href="struct_x_dp_rx_ss.html" title="The DisplayPort RX Subsystem driver instance data. ">XDpRxSs</a> driver. </p>
<p>This function will enable HDCP during DisplayPort RX Subsystem set up to work in MST/SST mode.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique device ID of the DisplayPort RX Subsystem core.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if DisplayPort RX Subsystem HDCP enabled successfully.</li>
<li>XST_FAILURE, otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dp_rx_ss___config.html#a51ebda7704c9682d7b8fc8073da88ad8">XDpRxSs_Config::BaseAddress</a>, <a class="el" href="xdprxss__debug__example_8c.html#a26fb3eace6447299bbdedd12b314a6a8">DpRxSs_PlatformInit()</a>, <a class="el" href="xdprxss__debug__example_8c.html#ae690e4e95545e8f6b37672430f1f910a">DpRxSs_Setup()</a>, <a class="el" href="xdprxss__debug__example_8c.html#a416674ea3b4fb518b781478d20c6bc51">DpRxSs_VideoPhyInit()</a>, <a class="el" href="struct_x_dp_rx_ss___usr_opt.html#a3b30d496a7ebaea9b6f78a4edd47e07a">XDpRxSs_UsrOpt::MstSupport</a>, <a class="el" href="struct_x_dp_rx_ss.html#afc12f403a17670fcf650b2056576785d">XDpRxSs::UsrOpt</a>, <a class="el" href="group__dprxss.html#ga25f3b6123ff5cbf277c4117617980738">XDpRxSs_CfgInitialize()</a>, <a class="el" href="group__dprxss.html#ga81fb45e531552358b584b48d5d1d65f5">XDpRxSs_LookupConfig()</a>, <a class="el" href="group__dprxss.html#ga180a0386c25a456d436bbfc9fec05c02">XDpRxSs_SetLaneCount()</a>, <a class="el" href="group__dprxss.html#gae447b427e7616d143f2170881fa79bb1">XDpRxSs_SetLinkRate()</a>, and <a class="el" href="group__dprxss.html#ga5ada36b95407b1169e183bbb7b9847d6">XDpRxSs_Start()</a>.</p>

<p>Referenced by <a class="el" href="xdprxss__hdcp__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a26fb3eace6447299bbdedd12b314a6a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 DpRxSs_PlatformInit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initialize required platform specific peripherals. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if required peripherals are initialized and configured successfully.</li>
<li>XST_FAILURE, otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="ae690e4e95545e8f6b37672430f1f910a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 DpRxSs_Setup </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures DisplayPort RX Subsystem. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if DPRX Subsystem configured successfully.</li>
<li>XST_FAILURE, otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="a416674ea3b4fb518b781478d20c6bc51"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 DpRxSs_VideoPhyInit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures Video Phy. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if Video Phy configured successfully.</li>
<li>XST_FAILURE, otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the main function for <a class="el" href="struct_x_dp_rx_ss.html" title="The DisplayPort RX Subsystem driver instance data. ">XDpRxSs</a> SST/MST example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the MST/SST example passed.</li>
<li>XST_FAILURE if the MST/SST example was unsuccessful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xdprxss__hdcp__example_8c.html#a33c9dce40424c29784819adc27eaf94e">DpRxSs_HdcpExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
